<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Download, unzip, read, clean the Facility Registry Service dataset — frs_get • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Download, unzip, read, clean the Facility Registry Service dataset — frs_get"><meta name="description" content="Download, unzip, read, clean the Facility Registry Service dataset"><meta property="og:description" content="Download, unzip, read, clean the Facility Registry Service dataset"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Download, unzip, read, clean the Facility Registry Service dataset</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/frs_get.R" class="external-link"><code>R/frs_get.R</code></a></small>
      <div class="d-none name"><code>frs_get.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Download, unzip, read, clean the Facility Registry Service dataset</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">frs_get</span><span class="op">(</span></span>
<span>  only_essential_cols <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  folder <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  downloaded_and_unzipped_already <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  zfile <span class="op">=</span> <span class="st">"national_single.zip"</span>,</span>
<span>  zipbaseurl <span class="op">=</span> <span class="st">"https://ordsext.epa.gov/FLA/www3/state_files/"</span>,</span>
<span>  csvname <span class="op">=</span> <span class="st">"NATIONAL_SINGLE.CSV"</span>,</span>
<span>  date <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-only-essential-cols">only_essential_cols<a class="anchor" aria-label="anchor" href="#arg-only-essential-cols"></a></dt>
<dd><p>TRUE by default. used in frs_read()</p></dd>


<dt id="arg-folder">folder<a class="anchor" aria-label="anchor" href="#arg-folder"></a></dt>
<dd><p>NULL by default which means it downloads to and unzips in a temporary folder</p></dd>


<dt id="arg-downloaded-and-unzipped-already">downloaded_and_unzipped_already<a class="anchor" aria-label="anchor" href="#arg-downloaded-and-unzipped-already"></a></dt>
<dd><p>If set to TRUE, looks in folder for csv file
instead of trying to download/unzip. Looks in working directory if folder not specified.</p></dd>


<dt id="arg-zfile">zfile<a class="anchor" aria-label="anchor" href="#arg-zfile"></a></dt>
<dd><p>filename, just use default unless EPA changes it</p></dd>


<dt id="arg-zipbaseurl">zipbaseurl<a class="anchor" aria-label="anchor" href="#arg-zipbaseurl"></a></dt>
<dd><p>url, just use default unless EPA changes it</p></dd>


<dt id="arg-csvname">csvname<a class="anchor" aria-label="anchor" href="#arg-csvname"></a></dt>
<dd><p>name of csv file. just use default unless EPA changes it</p></dd>


<dt id="arg-date">date<a class="anchor" aria-label="anchor" href="#arg-date"></a></dt>
<dd><p>default is Sys.Date() which is today, but this is used as
an attribute assigned to the results,
representing the vintage, such as the date the frs was downloaded, obtained.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Used by <code><a href="frs_update_datasets.html">frs_update_datasets()</a></code></p>
<p>Uses <code><a href="frs_download.html">frs_download()</a></code>, <code><a href="frs_unzip.html">frs_unzip()</a></code>, <code><a href="frs_read.html">frs_read()</a></code>, <code><a href="frs_clean.html">frs_clean()</a></code></p>
<p><strong>See examples for how package maintainer might use this.</strong></p>
<p>See source code of this function for more notes.
For a developer updating the frs datasets in this package,
see <code><a href="frs_update_datasets.html">frs_update_datasets()</a></code></p>
<p>frs_get() invisibly returns the table of data, as a data.table.
It will download, unzip, read, clean, and set metadata for the data.</p>
<p>This function gets the whole thing in one file from</p>
<p>NATIONAL_SINGLE.CSV from
<a href="https://ordsext.epa.gov/FLA/www3/state_files/national_single.zip" class="external-link">https://ordsext.epa.gov/FLA/www3/state_files/national_single.zip</a></p>
<p>Other files and related information:</p><ul><li><p><a href="https://www.epa.gov/frs/frs-data-resources" class="external-link">https://www.epa.gov/frs/frs-data-resources</a></p></li>
<li><p><a href="https://www.epa.gov/frs/geospatial-data-download-service" class="external-link">https://www.epa.gov/frs/geospatial-data-download-service</a></p></li>
<li><p><a href="https://www.epa.gov/frs/epa-frs-facilities-state-single-file-csv-download" class="external-link">https://www.epa.gov/frs/epa-frs-facilities-state-single-file-csv-download</a></p></li>
<li><p>Also could download individual files from ECHO for parts of the info:
<a href="https://echo.epa.gov/tools/data-downloads/frs-download-summary" class="external-link">https://echo.epa.gov/tools/data-downloads/frs-download-summary</a>
for a description of other related files available from EPA's ECHO.</p></li>
</ul><p>This function creates the following:</p>
<div class="sourceCode"><pre><code>

 &gt; head(frs_by_programid)
           lat        lon  REGISTRY_ID   program   pgm_sys_id
   1: 44.13415 -104.12563 110012799846     STATE        #5005
   2: 41.16163  -80.07847 110057783590 PA-EFACTS         ++++
   3: 41.21463 -111.96224 110020117862       CIM            0
   4: 29.62889  -83.10833 110040716473 LUST-ARRA            0
   5: 40.71490  -74.00316 110019246163       FIS 0-0000-01097
   6: 40.76395  -73.97037 110019163359       FIS 0-0000-01103

   &gt; frs_by_naics[1:2, ]
           lat        lon  REGISTRY_ID NAICS
   1: 30.33805  -87.15616 110002524055     0
   2: 48.77306 -104.56154 110007654038     0

   &gt; names(frs)
   "lat"    "lon"   "REGISTRY_ID" "PRIMARY_NAME" "NAICS" "PGM_SYS_ACRNMS"

    &gt; head(frs[,1:4]) # looks something like this:
           lat       lon  REGISTRY_ID                    PRIMARY_NAME
   1: 18.37269 -66.14207 110000307695      xyz CHEMICALS INCORPORATED
   x: 17.98615 -66.61845 110000307784                         ABC INC
   x: 17.94930 -66.23170 110000307800                   COMPANY QRSTU


  **WHICH SITES ARE ACTIVE VS INACTIVE SITES**

 See frs_active_ids() or frs_inactive_ids()

 Approx 4.6 million rows total 10/2022.

 table(is.na(frs$lat))
 table(is.na(frs$NAICS))

 It is not entirely clear how to simply identify
 which ones are active vs inactive sites.
 See inst folder for notes on that.
 This as of 2/10/23 is not exactly how ECHO/OECA defines "active"

  **WHICH SITES HAVE LAT LON INFO**

 As of 2022-01-31:  Among all including inactive sites,

  1/3 have no latitude or longitude.
  Even those with lat lon have some problems:
    Some are are not in the USA.
    Some have errors in country code.
    Some use alternate ways of specifying USA.

  **WHICH SITES HAVE NAICS OR SIC INDUSTRY CODES**

 Only 1/4 have both location and some industry code (27<!-- %) -->

 2/3 lack industry code (have no NAICS and no SIC).
    NAICS vs SIC codes:
 11 percent have both NAICS and SIC,
 9.5 percent have just NAICS =
    (21 percent have NAICS).
 12.5 percent have just SIC.
 2/3 have neither NAICS nor SIC.


  **WHICH COLUMNS TO IMPORT AND KEEP**

 approx 39 columns if all are imported, but most useful 10 is default.

 [1] "REGISTRY_ID"             "PRIMARY_NAME"        "PGM_SYS_ACRNMS"
 [4] "INTEREST_TYPES"    "NAICS_CODES"       "NAICS_CODE_DESCRIPTIONS"
 [7] "SIC_CODES"       "SIC_CODE_DESCRIPTIONS"  "LATITUDE83"
 [10] "LONGITUDE83"


  Some fields are csv lists actually, to be split into separate rows
   to enable queries on NAICS code or program system id:

  PGM_SYS_ACRNMS = 'c', # csv format like AIR:AK999, AIRS/AFS:123,
     NPDES:AK0020630, RCRAINFO:AK6690360312, RCRAINFO:AKR000206516"
  INTEREST_TYPES = 'c', # eg "AIR SYNTHETIC MINOR, ICIS-NPDES NON-MAJOR"
      NAICS_CODES = 'c',  # csv of NAICS
</code></pre></div>

    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="frs_update_datasets.html">frs_update_datasets()</a></code> <code><a href="frs_read.html">frs_read()</a></code> <code><a href="frs_clean.html">frs_clean()</a></code> frs_by_naics <code><a href="frs_active_ids.html">frs_active_ids()</a></code>
<code><a href="frs_drop_inactive.html">frs_drop_inactive()</a></code> <code><a href="frs_make_programid_lookup.html">frs_make_programid_lookup()</a></code> <code><a href="frs_make_naics_lookup.html">frs_make_naics_lookup()</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>

    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

